Web API

The REST-based APIs allow external applications and integration tools to:

  • Extend the functionality of PlanningSpace.
  • Integrate PlanningSpace with other systems.
  • Automate processes.

Four APIs provide access to application functionality:

  • Dataflow Web API
  • Economics Web API
  • Financials Web API
  • Economics Calculation API (only available in version 16.5 Update 10 and later)

And two APIs provide administration functionality:

  • PlanningSpace Web API
  • IPS Server Monitor Tenant API

For version 16.5 Update 13 and later: The Server Monitor Tenant API can be disabled using the IPS service setting 'Enable Server Monitor'. When disabled, all back-end data collection and API endpoints are stopped; and the Server Monitor user interfaces in IPS Manager and PlanningSpace are removed.

See the API Reference (PlanningSpace version: 16.5 Update 32 (16.5.32)) section for reference information about the individual APIs.

Important: For correct API reference information, you should ensure that the version of this document matches with the version of your PlanningSpace server. See the value of 'Software version' in the page footer below.

Changes to the APIs that have been made in PlanningSpace 16.5 Update releases are listed in the API Change Logs page.

 

IN THIS SECTION